API Documentation
ComboBox.h
1 // ComboBox.h
3 //
5 
6 namespace nkWinUi
7 {
11  class ComboBox : public Component
12  {
13  public :
14 
18  class Entry final
19  {
20  public :
21 
25  Entry () ;
29  ~Entry () ;
30 
31  // Getters
39  void* getAttachedData () const ;
40 
41  // Setters
47  void setLabel (const nkMemory::StringView& label) ;
55  void setAttachedData (void* data) ;
56  } ;
57 
58  public :
59 
65  ComboBox () ;
69  ~ComboBox () ;
70 
71  // Getters
82  Entry* getEntryPerData (void* data) const ;
86  virtual Entry* getCurrentSelection () const ;
91 
92  // Setters
110  void setSelectedEntryPerData (void* data) ;
116  virtual void setSelectedEntry (Entry* selected) ;
117 
118  // Entries
128  virtual Entry* insertEntry (const nkMemory::StringView& label, void* data) ;
135  void setEntryData (const nkMemory::StringView& label, void* newData) ;
141  virtual void* deleteEntry (const nkMemory::StringView& label) ;
145  virtual void clearEntries () ;
146 
150  virtual void exportIntrospection (nkExport::Node* rootNode) override ;
154  virtual void importClassFromTree (nkExport::Node* rootNode) override ;
155  } ;
156 }
nkWinUi::ComboBox::insertEntry
virtual Entry * insertEntry(const nkMemory::StringView &label, void *data)
nkWinUi::ComboBox::exportIntrospection
virtual void exportIntrospection(nkExport::Node *rootNode) override
nkWinUi::ComboBox::ComboBox
ComboBox()
nkWinUi::ComboBox::~ComboBox
~ComboBox()
nkWinUi::ComboBox::Entry
Represents an entry within the combo box.
Definition: ComboBox.h:19
nkWinUi::ComboBox::Entry::setLabel
void setLabel(const nkMemory::StringView &label)
nkWinUi::ComboBox::clearEntries
virtual void clearEntries()
nkWinUi::ComboBox::Entry::getAttachedData
void * getAttachedData() const
nkWinUi::Component
Base class for any graphical component.
Definition: Component.h:12
nkWinUi::ComboBox::Entry::getLabel
nkMemory::StringView getLabel() const
nkWinUi::ComboBox
A graphical combo box.
Definition: ComboBox.h:12
nkWinUi::ComboBox::setSelectedEntryPerLabel
void setSelectedEntryPerLabel(const nkMemory::StringView &label)
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkWinUi::ComboBox::Entry::~Entry
~Entry()
nkWinUi::ComboBox::setSelectionSpecializedCallback
void setSelectionSpecializedCallback(comboSelectionCallback value)
nkWinUi::comboSelectionCallback
std::function< bool(ComboBox *caller)> comboSelectionCallback
Used by a nkWinUi::ComboBox to signal selection changed.
Definition: CallbackRepository.h:110
nkWinUi::ComboBox::getEntryPerData
Entry * getEntryPerData(void *data) const
nkWinUi::ComboBox::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode) override
nkWinUi::ComboBox::Entry::Entry
Entry()
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkWinUi::ComboBox::setSelectedEntry
virtual void setSelectedEntry(Entry *selected)
nkWinUi::ComboBox::deleteEntry
virtual void * deleteEntry(const nkMemory::StringView &label)
nkWinUi::ComboBox::setSelectedEntryPerData
void setSelectedEntryPerData(void *data)
nkWinUi::ComboBox::getSelectionSpecializedCallback
comboSelectionCallback getSelectionSpecializedCallback() const
nkWinUi::ComboBox::Entry::setAttachedData
void setAttachedData(void *data)
nkWinUi::ComboBox::setEntryData
void setEntryData(const nkMemory::StringView &label, void *newData)
nkWinUi
Encompasses all API of component NilkinsWinUi.
Definition: Button.h:7
nkWinUi::ComboBox::getEntryPerLabel
Entry * getEntryPerLabel(const nkMemory::StringView &label) const
nkWinUi::ComboBox::getCurrentSelection
virtual Entry * getCurrentSelection() const